org.eclipse.vtp.framework.core
Interface IActionContext

All Superinterfaces:

IContext, IExecutionContext, ILogger, IProcessContext, IReporter, ISessionContext

All Known Implementing Classes:

AbstractActionContext, ActionContextWrapper, Sequence.Context

public interface IActionContext
extends IExecutionContext

A service available to services at the action scope.

Author:

Lonnie Pryor

Field Summary

static int	STATE_AFTER After the action has been run.
static int	STATE_BEFORE Before the action has been run.
static int	STATE_DURING While the action is running.

Fields inherited from interface org.eclipse.vtp.framework.core.IReporter

SEVERITY_DEBUG, SEVERITY_ERROR, SEVERITY_INFO, SEVERITY_WARN

Method Summary

IActionResult	createResult(java.lang.String resultName) Creates an action result with the specified name.
IActionResult	createResult(java.lang.String resultName, java.lang.Throwable failureCause) Creates an action result with the specified name.
java.lang.String	getActionID() Returns the ID of the current action.
java.lang.String	getActionName() Returns the name of the current action.
int	getActionState() Returns the state of the current action.

Methods inherited from interface org.eclipse.vtp.framework.core.IExecutionContext

clearParameter, getExecutionID, getParameter, getParameterNames, getParameters, setParameter, setParameters

Methods inherited from interface org.eclipse.vtp.framework.core.ISessionContext

clearAttribute, getAttribute, getAttributeNames, getSessionID, setAttribute

Methods inherited from interface org.eclipse.vtp.framework.core.IProcessContext

getProcessID, getProperty, loadClass

Methods inherited from interface org.eclipse.vtp.framework.core.IContext

lookup, lookupAll

Methods inherited from interface org.eclipse.vtp.framework.core.ILogger

debug, debug, debug, debug, error, error, error, error, info, info, info, info, isDebugEnabled, isErrorEnabled, isInfoEnabled, isWarnEnabled, log, log, log, log, warn, warn, warn, warn

Methods inherited from interface org.eclipse.vtp.framework.core.IReporter

isSeverityEnabled, report, report, report, report

Field Detail

STATE_BEFORE

static final int STATE_BEFORE

Before the action has been run.

See Also:

Constant Field Values

STATE_DURING

static final int STATE_DURING

While the action is running.

See Also:

Constant Field Values

STATE_AFTER

static final int STATE_AFTER

After the action has been run.

See Also:

Constant Field Values

Method Detail

getActionID

java.lang.String getActionID()

Returns the ID of the current action.

Returns:

The ID of the current action.

getActionName

java.lang.String getActionName()

Returns the name of the current action.

Returns:

The name of the current action.

getActionState

int getActionState()

Returns the state of the current action.

Returns:

The state of the current action.

createResult

IActionResult createResult(java.lang.String resultName)

Creates an action result with the specified name.

Parameters:

resultName - The name of the result to create or null to create an undefined result.

Returns:

A new action result with the specified name.

createResult

IActionResult createResult(java.lang.String resultName,
                           java.lang.Throwable failureCause)

Creates an action result with the specified name.

Parameters:

resultName - The name of the result to create or null to create an undefined result.

failureCause - The cause of the failure the action result represents or null to not specify a failure cause.

Returns:

A new action result with the specified name and failure cause.